Open
Conversation
This commit introduces documentation validation system that ensures our published CLI examples remain executable and up to date. Summary of Changes: - `ci/select-doc-pages.py`: builds an ordered execution plan from changed snippet files and their declared dependencies (`# @Depends:`). - `ci/run-doc-pages.py`: extracts and runs (or dry-runs) `[docs-exec:*]` blocks from snippet files in sequential order. - `[docs-view:*]` blocks: used for display in documentation via `literalinclude`, ensuring examples in the docs match what CI validates. - Unit tests for both selector and runner using pytest. - Updated GitHub Actions workflow for automatic snippet validation. - Added `ci/README.md` explaining the framework, usage, and conventions.
freyes
requested changes
Oct 21, 2025
|
|
||
| defaults: | ||
| run: | ||
| shell: bash |
There was a problem hiding this comment.
nit, you can achieve the same with something like this:
- name: Foo
run: |
#!/bin/bash
for FOO in $(ls *.txt); do
...
note: I won't block the PR on this, it's more a personal preference that allows to keep the interpreter that will be used and the code together
MylesJP
force-pushed
the
docs-validation
branch
2 times, most recently
from
175bb07 to
f414cd7
Compare
MylesJP
force-pushed
the
docs-validation
branch
from
f414cd7 to
8c1a9f9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces documentation validation system that ensures our published CLI examples remain executable and up to date with the product available to users. Note this initial PR is set to dry run only. See the Follow Up section below for a description of future work.
Summary of Changes:
[docs-exec:*]blocks from snippet files in sequential order.Follow-up: